subtract
Type
command
Summary
Subtracts a number from a container and places the resulting value in the container.
Syntax
subtract <number> from [<chunk> of] <container>
subtract {<number> | <array>} from <arrayContainer>
Description
Use the subtract command to subtract a number from a container or a portion of a container, or to subtract two arrays containing numbers.
The contents of the container (or the chunk of the container) must be a number or an expression that evaluates to a number.
If a number is subtracted from an arrayContainer, the number is subtracted from each element. If an array is subtracted from an arrayContainer, both arrays must have the same number of elements and the same dimension, and each element in the array is subtracted from the corresponding element of the arrayContainer.
If the container or an element of the arrayContainer is empty, the subtract command treats its contents as zero.
If container is a field or button, the format of the sum is determined by the numberFormat property.
If a math operation on finite inputs produces a non-finite output, an execution error is thrown. See math operations for more information.
Parameters
| Name | Type | Description |
|---|---|---|
number | Any expression that evaluates to a number. | |
chunk | A chunk expression specifying a portion of the container. | |
container | A field, button, or variable, or the message box. | |
array | array | |
arrayContainer | array | An array variable each of whose elements is a number. |
Examples
subtract 5 from tSize
put "10,10" into tPoint
subtract 5 from item 2 of tPoint -- subtracts 5 from the second item
# RESULT
# tPoint = 10,5
put 10 into tArray["height"]
put 10 into tArray["width"]
subtract 5 from tArray -- subtracts 5 from both width and height
# RESULT
# tArray["height"] = 5
# tArray["width"] = 5
Related
command: multiply
glossary: property, element, container, expression, array, evaluate, command, math operation
keyword: field, element, button
operator: dash
property: numberFormat
Compatibility and Support
Introduced
LiveCode 1.0
OS
mac
windows
linux
ios
android
Platforms
desktop
server
mobile